Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardise project structure for the Pallets Ecosystem #2436

Merged
merged 3 commits into from
Jul 8, 2024
Merged

Standardise project structure for the Pallets Ecosystem #2436

merged 3 commits into from
Jul 8, 2024

Conversation

samuelhwilliams
Copy link
Contributor

@samuelhwilliams samuelhwilliams commented Jul 5, 2024

Copies across, and then customises, the Pallets Ecosystem standard project structure from Flask-DebugToolbar

The tests throw a number of warnings, which are now being flagged as errors because of the standard project config. I've suppressed a number of these where it feels appropriate, but probably worth discussing if it's right to suppress them here or if we should immediately fix them. I suspect a number of them should be addressed in separate issues, eg things around DeprecationWarnings.

The test requirements file is a lot more complex for this project than for FDT, so I'm not sure we can freeze it in the same way. I have kept a tests.in file, with the existing test_requires from the original setup.py; not sure what we would want to do about this.

I suspect we may also need to disable the typing check and address that in a separate PR.

fixes: #2435

Copy link
Member

@Abdur-rahmaanJ Abdur-rahmaanJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Now, once merged, we need to fix CI/CD issues!

@aenglander

@samuelhwilliams samuelhwilliams marked this pull request as ready for review July 8, 2024 03:33
@aenglander aenglander merged commit 1247073 into pallets-eco:master Jul 8, 2024
6 of 7 checks passed
@aenglander aenglander self-assigned this Jul 8, 2024
@aenglander
Copy link
Contributor

aenglander commented Jul 8, 2024

LGTM. Now, once merged, we need to fix CI/CD issues!

@aenglander

@Abdur-rahmaanJ The only thing that seems to need fixing is typing. If the library isn't ready for typing checks, the test should be disabled, and a ticket should be created to add type support.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Mirror Pallets-eco setup for projects
3 participants